/*
 * Copyright (c) 2021, 2021, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.graal.pointsto.meta;

import java.util.Collection;

import jdk.vm.ci.code.BytecodePosition;

/**
 * Provides analysis related information for each invoke in AnalysisMethod's StructuredGraph. It was
 * created as an abstraction to encapsulate InvokeTypeFlow.
 */
public interface InvokeInfo {

    boolean canBeStaticallyBound();

    AnalysisMethod getTargetMethod();

    /**
     * Retrieves a list of all callees whose MultiMethodKey is {@code ORIGINAL_METHOD}. All of these
     * callees will also be {@link AnalysisMethod#isImplementationInvoked()}.
     */
    Collection<AnalysisMethod> getOriginalCallees();

    /**
     * Retrieves list of all callees. Note that callees in this list can have a MultiMethodKey
     * different from ORIGINAL_METHOD and also may not be
     * {@link AnalysisMethod#isImplementationInvoked()}.
     */
    Collection<AnalysisMethod> getAllCallees();

    BytecodePosition getPosition();

    boolean isDirectInvoke();

    default boolean isDeoptInvokeTypeFlow() {
        return false;
    }
}
